home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmNotebookGetPageInfo.z / XmNotebookGetPageInfo
Encoding:
Text File  |  2002-10-03  |  6.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmNNNNooootttteeeebbbbooooooookkkkGGGGeeeettttPPPPaaaaggggeeeeIIIInnnnffffoooo((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmNNNNooootttteeeebbbbooooooookkkkGGGGeeeettttPPPPaaaaggggeeeeIIIInnnnffffoooo((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmNNNNooootttteeeebbbbooooooookkkkGGGGeeeettttPPPPaaaaggggeeeeIIIInnnnffffoooo - A Notebook function that returns
  10.           page information
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Notebook.h>
  14.           XXXXmmmmNNNNooootttteeeebbbbooooooookkkkPPPPaaaaggggeeeeSSSSttttaaaattttuuuussss XXXXmmmmNNNNooootttteeeebbbbooooooookkkkGGGGeeeettttPPPPaaaaggggeeeeIIIInnnnffffoooo(
  15.           WWWWiiiiddddggggeeeetttt nnnnooootttteeeebbbbooooooookkkk,
  16.           iiiinnnntttt ppppaaaaggggeeee____nnnnuuuummmmbbbbeeeerrrr,
  17.           XXXXmmmmNNNNooootttteeeebbbbooooooookkkkPPPPaaaaggggeeeeIIIInnnnffffoooo ****ppppaaaaggggeeee____iiiinnnnffffoooo);
  18.  
  19.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  20.           This page documents Motif 2.1.
  21.  
  22.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.           XXXXmmmmNNNNooootttteeeebbbbooooooookkkkGGGGeeeettttPPPPaaaaggggeeeeIIIInnnnffffoooo returns status information for the
  24.           specified Notebook page.
  25.  
  26.           _n_o_t_e_b_o_o_k  Specifies the Notebook widget.
  27.  
  28.           _p_a_g_e__n_u_m_b_e_r
  29.                     Specifies the page number to be queried.
  30.  
  31.           _p_a_g_e__i_n_f_o Points to the structure containing the page
  32.                     information. The structure has the following form:
  33.  
  34.           typedef struct
  35.           {
  36.                   int     _p_a_g_e__n_u_m_b_e_r;
  37.                   Widget  _p_a_g_e__w_i_d_g_e_t;
  38.                   Widget  _s_t_a_t_u_s__a_r_e_a__w_i_d_g_e_t;
  39.                   Widget  _m_a_j_o_r__t_a_b__w_i_d_g_e_t;
  40.                   Widget  _m_i_n_o_r__t_a_b__w_i_d_g_e_t;
  41.           } XmNotebookPageInfo;
  42.           (vvvvooooiiiidddd)
  43.  
  44.                _p_a_g_e__n_u_m_b_e_r
  45.                          Specifies the _p_a_g_e__n_u_m_b_e_r passed to the
  46.                          function.
  47.  
  48.                _p_a_g_e__w_i_d_g_e_t
  49.                          Specifies a child widget of the Notebook with
  50.                          a XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee of XXXXmmmmPPPPAAAAGGGGEEEE and a XXXXmmmmNNNNppppaaaaggggeeeeNNNNuuuummmmbbbbeeeerrrr
  51.                          equal to _p_a_g_e__n_u_m_b_e_r if one exists; otherwise
  52.                          set to NULL.
  53.  
  54.                _s_t_a_t_u_s__a_r_e_a__w_i_d_g_e_t
  55.                          Specifies a child widget of the Notebook with
  56.                          a XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee of XXXXmmmmSSSSTTTTAAAATTTTUUUUSSSS____AAAARRRREEEEAAAA and a
  57.                          XXXXmmmmNNNNppppaaaaggggeeeeNNNNuuuummmmbbbbeeeerrrr equal to _p_a_g_e__n_u_m_b_e_r if one
  58.                          exists; otherwise set to NULL.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmNNNNooootttteeeebbbbooooooookkkkGGGGeeeettttPPPPaaaaggggeeeeIIIInnnnffffoooo((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmNNNNooootttteeeebbbbooooooookkkkGGGGeeeettttPPPPaaaaggggeeeeIIIInnnnffffoooo((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                _m_a_j_o_r__t_a_b__w_i_d_g_e_t
  75.                          Specifies a child widget of the Notebook with
  76.                          a XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee of XXXXmmmmMMMMAAAAJJJJOOOORRRR____TTTTAAAABBBB and the nearest
  77.                          XXXXmmmmNNNNppppaaaaggggeeeeNNNNuuuummmmbbbbeeeerrrrequal to or less than
  78.                          _p_a_g_e__n_u_m_b_e_r if one exists; otherwise set to
  79.                          NULL.
  80.  
  81.                _m_i_n_o_r__t_a_b__w_i_d_g_e_t
  82.                          Specifies a child widget of the Notebook with
  83.                          a XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee of XXXXmmmmMMMMIIIINNNNOOOORRRR____TTTTAAAABBBB and the nearest
  84.                          XXXXmmmmNNNNppppaaaaggggeeeeNNNNuuuummmmbbbbeeeerrrrequal to or less than
  85.                          _p_a_g_e__n_u_m_b_e_r if one exists; otherwise set to
  86.                          NULL.
  87.  
  88.           For a complete definition of Notebook and its associated
  89.           resources, see XXXXmmmmNNNNooootttteeeebbbbooooooookkkk(3).
  90.  
  91.      RRRREEEETTTTUUUURRRRNNNN
  92.           Returns one of the following page status values:
  93.  
  94.           XXXXmmmmPPPPAAAAGGGGEEEE____FFFFOOOOUUUUNNNNDDDD
  95.                     The specified page was found.
  96.  
  97.           XXXXmmmmPPPPAAAAGGGGEEEE____IIIINNNNVVVVAAAALLLLIIIIDDDD
  98.                     The specified page number is out of the page
  99.                     number range.
  100.  
  101.           XXXXmmmmPPPPAAAAGGGGEEEE____EEEEMMMMPPPPTTTTYYYY
  102.                     The specified page does not have a page widget.
  103.  
  104.           XXXXmmmmPPPPAAAAGGGGEEEE____DDDDUUUUPPPPLLLLIIIICCCCAAAATTTTEEEEDDDD
  105.                     There is more than one page widget with the
  106.                     specified page number. The more recently managed
  107.                     page widget is used for the page information
  108.                     structure.
  109.  
  110.      RRRREEEELLLLAAAATTTTEEEEDDDD
  111.           XXXXmmmmNNNNooootttteeeebbbbooooooookkkk(3).
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.